Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename split_line -> splitLine in InstrumentTXTResultsFileParser for consistency #2445

Merged
merged 2 commits into from
Dec 19, 2023

Conversation

fengyundeng
Copy link
Contributor

Description of the issue/feature this PR addresses

Linked issue: https://github.com/senaite/senaite.core/issues/

Current behavior before PR

class InstrumentCSVResultsFileParser(InstrumentResultsFileParser)
def splitLine(self, line)

class InstrumentTXTResultsFileParser(InstrumentResultsFileParser)
def split_line(self, line)

Desired behavior after PR is merged

keep the same class-method name in "class InstrumentTXTResultsFileParser(InstrumentResultsFileParser)", as in "class InstrumentCSVResultsFileParser(InstrumentResultsFileParser)"

I confirm I have tested this PR thoroughly and coded it according to PEP8
and Plone's Python styleguide standards.

keep the same class-method name in "class InstrumentTXTResultsFileParser(InstrumentResultsFileParser)", as in "class InstrumentCSVResultsFileParser(InstrumentResultsFileParser)"
@ramonski ramonski changed the title keep the same class-method name in both Rename split_line -> splitLine in InstrumentTXTResultsFileParser for consistency Dec 11, 2023
Copy link
Contributor

@ramonski ramonski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the consistency change @fengyundeng!

Would you mind to add a changelog entry on top of the file https://github.com/senaite/senaite.core/blob/2.x/CHANGES.rst with the updated title?

@fengyundeng
Copy link
Contributor Author

Hi @ramonski , the CHANGES.rst is updated.
BTW, is it better to "Pull requests and add CHANGES.rst at the same time" when i could contribute some in project in future?

@ramonski
Copy link
Contributor

Hi @fengyundeng,

The update to the changelog are not yet pushed to this PR, see
https://github.com/senaite/senaite.core/pull/2445/files

Regarding your question:
You need to first create a PR to get a number. In your case #2445.
This PR number is then referred in the changelog, e.g.:

Changelog
=========

2.5.0 (unreleased)
------------------

- #2445 Rename split_line -> splitLine in InstrumentTXTResultsFileParser for consistency
- ...

Please always put your changelog above the others, so that we have a proper order.

Thanks!

@ramonski ramonski mentioned this pull request Dec 12, 2023
@ramonski
Copy link
Contributor

Hi @fengyundeng,
would you mind to add the changelog line you did in #2447 into this PR please?
Thanks

@fengyundeng
Copy link
Contributor Author

Hi @ramonski , i tried to, but i didn't find where to add CHANGES.rst to "Files changed" in this PR.
Each time when i edited CHANGES.rst, i always need to create a new PR?
sorry. i'm a new guy in github.

@ramonski
Copy link
Contributor

Hi @fengyundeng,
no worries, then we merge both of your PRs to keep it simple.
Thanks for your your contribution!

@ramonski ramonski merged commit 6b311ec into senaite:2.x Dec 19, 2023
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants